home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / DEVELOP.ZIP / USERS.DOC < prev    next >
Text File  |  1996-07-23  |  5KB  |  118 lines
  1.   WARNING:  This document is subject to change at any time.  Any changes made
  2.   will be indicated by a vertical bar (|) in column 1 of the file.
  3.  
  4. | Last update: 07/23/96
  5.  
  6. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  7.  
  8.   The following information documents the format for PCBoard's USERS file
  9.   and index files format.  The format of the USERS.INF file is documented
  10.   separately in a file called USERSYS.DOC.
  11.  
  12.   Each user record is 400 bytes in length.  There are no headers or other
  13.   special considerations contained within the users file.  Therefore, a
  14.   users file with 4 user records would be 1600 bytes in length.
  15.  
  16.   The following layout is specified in a "byte offset" format such that the
  17.   first field begins at offset 0.
  18.  
  19.   The following is a definition of the variable types that will be used below:
  20.  
  21.     int    = a 2 byte value used to form an unsigned integer word
  22.     long   = a 4 byte value used to form a long integer
  23.     char   = a 1 byte character
  24.     str    = an array of 2 or more "char" bytes
  25.     bsreal = a 4 byte Basic Single Precision real number
  26.     bdreal = an 8 byte Basic Double Precision real number
  27.     bitmap = 1 or more bytes used to store bit flags
  28.  
  29.   Note that strings are not NULL terminated and that the length specified for
  30.   the string is full number of useable and storeable bytes.  All strings are
  31.   padded with spaces to fill the entire field.
  32.  
  33.   USERS FILE
  34.   ==========
  35.  
  36.     Offset   Type   Length  Description
  37.     ------  ------  ------  -----------
  38.        0    str       25    Full Name
  39.       25    str       24    City
  40.       49    str       12    Password
  41.       61    str       13    Business / Data Phone Number
  42.       74    str       13    Home / Voice Phone Number
  43.       87    str        6    Last Date On (format:  YYMMDD)
  44.       93    str        5    Last Time On (format HH:MM)
  45.       98    char       1    Expert Mode (Y or N)
  46.       99    char       1    Default Transfer Protocol (A-Z, 0-9)
  47.      100    bitmap     1    Bit Flags (see below)
  48.      101    str        6    Date of Last DIR Scan (most recent file found)
  49.      107    char       1    Security Level (0-255)
  50.      108    int        2    Number of Times On
  51.      110    char       1    Page Length (# lines displayed before prompt)
  52.      111    int        2    Number of Files Uploaded
  53.      113    int        2    Number of Files Downloaded
  54.      115    bdreal     8    Total Bytes Downloaded Today
  55.      123    str       30    Comment Field #1 (user comment)
  56.      153    str       30    Comment Field #2 (sysop comment - user can't see)
  57.      183    int        2    Elapsed Time On (in minutes)
  58.      185    str        6    Registration Expiration Date (YYMMDD)
  59.      191    char       1    Expired Registration - Security Level
  60.      192    char       1    Last Conference In (used for v14.x compatibility)
  61.      193    bitmap     5    Conference Registration Flags (conf 0-39)
  62.      198    bitmap     5    Expired Registration Conference Flags (conf 0-39)
  63.      203    bitmap     5    User Selected Conference Flags (conf 0-39)
  64.      208    bdreal     8    Total Bytes Downloaded
  65.      216    bdreal     8    Total Bytes Uploaded
  66.      224    char       1    Delete Flag (Y or N)
  67.      225    bsreal     4    Last Message Read pointer (conference 0)
  68.      229    bsreal     4    Last Message Read pointer (conference 1)
  69.      ...    bsreal     4    (continued each conference)
  70.      381    bsreal     4    Last Message Read pointer (conference 39)
  71.      385    long       4    Record Number of USERS.INF Record
  72.      389    bitmap     1    Bit Flags 2 (see below)
  73.      390    str        8    Reserved (do not use)
  74.      398    int        2    Last Conference In (used instead of offset 192)
  75.  
  76.  
  77.   Bit Flags
  78.   ---------
  79.   The bit flags are used to store the status of several flags using only a
  80.   single byte to store them.  They are stored in the following order:
  81.  
  82.   Bit 0 = Dirty Flag (used to indicate another process updated the record)
  83.   Bit 1 = Clear Screen Between Messages
  84.   Bit 2 = Has Mail Flag
  85.   Bit 3 = Don't Ask for Full Screen Editor Use
  86.   Bit 4 = Full Screen Editor Default
  87.   Bit 5 = Scroll Message Body
  88.   Bit 6 = Use Short Message Headers
  89.   Bit 7 = Use Wide (79-column) Editor
  90.  
  91.   Bit Flags 2
  92.   -----------
  93.   The bit flags are used to store the status of several flags using only a
  94.   single byte to store them.  They are stored in the following order:
  95.  
  96.   Bit 0 = Chat Status - OFF=Available, ON=unavailable
  97. | Bit 1 = Display short file descriptions
  98.   Bit 2 = reserved
  99.   Bit 3 = reserved
  100.   Bit 4 = reserved
  101.   Bit 5 = reserved
  102.   Bit 6 = reserved
  103.   Bit 7 = reserved
  104.  
  105.   USER INDEX FILES
  106.   ================
  107.  
  108.     Offset   Type   Length  Description
  109.     ------  ------  ------  -----------
  110.        0    int        2    Record Number in USERS File
  111.        2    str       25    Full Name
  112.  
  113.   There are 26 separate index files for the users.  They are separated into
  114.   PCNDX.A thru PCBNDX.Z storing names beginning with the letters "A" thru "Z"
  115.   respectively.  Names starting with character before ascii "A" are stored in
  116.   the PCBNDX.A file and similarly names starting with characters after ascii
  117.   "A" are stored in the PCBNDX.Z file.
  118.